/*
 * Copyright (c) 2004-2005 The Regents of The University of Michigan
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met: redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer;
 * redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution;
 * neither the name of the copyright holders nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * Authors: Kevin Lim
 */

#ifndef __CPU_EDGE_CTB_HH__
#define __CPU_EDGE_CTB_HH__

#include "base/misc.hh"
#include "base/types.hh"
#include "config/the_isa.hh"
#include "arch/isa_traits.hh"

class DefaultCTB
{
  private:
   	typedef TheISA::ExitID ExitID;
  	struct CTBEntry
  	{
  	    Addr call_target;
	    bool call_target_hyst;
	    bool call_updated;
	    Addr ret_addr_offset;
	    bool ret_addr_hyst;
	    bool ret_updated;
  	};
   public:
	
   	DefaultCTB() {}

	~DefaultCTB() {}

	void init(unsigned numEntries,
                      unsigned blockShiftAmt,
                      unsigned offsetLength);

	void reset();
	
       unsigned CTBIdxGen(Addr PC, int addr_space_ID, ExitID exitID);

	Addr lookupTarget(Addr PC,int addr_space_ID, ExitID pred_exitID);

	Addr lookupRetAddr(Addr PC,int addr_space_ID, ExitID pred_exitID);
    
       /**Update when a call commit. */
	void update(unsigned index, Addr target);

       /** Update when a return commit. */
	void update(unsigned index, Addr block_addr, Addr target);

  private:
  	std::vector<CTBEntry> ctb;

	unsigned numEntries;

	unsigned blockShiftAmt;

	unsigned ctbMask;

	unsigned ctbIdxLength;

       unsigned offsetLength;

	unsigned offsetMask;
};

#endif // _CPU_EDGE_CTB_HH_
